/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package nl.jteam.jsa.core;

/**
 * Represent a searchable element that can boosted. A boost serves as a hint to the search engine indicating how
 * to rank the seachable element when it is returned as a search result.
 *
 * @author Uri Boness
 */
public interface Boostable {

    public final static float DEFAULT_BOOST = 1.0f;

    /**
     * Returns the boost factor of this searchable element.
     *
     * @return The boost factor of this searchable element.
     */
    float getBoost();

}
